package com.jprocms.module.cms.service.vote;

import com.jpro.framework.common.pojo.PageResult;
import com.jprocms.module.cms.controller.admin.vote.vo.VoteCreateReqVO;
import com.jprocms.module.cms.controller.admin.vote.vo.VoteListReqVO;
import com.jprocms.module.cms.controller.admin.vote.vo.VotePageReqVO;
import com.jprocms.module.cms.controller.admin.vote.vo.VoteUpdateReqVO;
import com.jprocms.module.cms.dal.dataobject.vote.VoteDO;
import org.springframework.lang.Nullable;

import javax.validation.Valid;
import java.util.Collection;
import java.util.List;

/**
 * 投票 Service 接口
 *
 * @author jprocms
 */
public interface VoteService {

    /**
     * 创建投票
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    Long createVote(@Valid VoteCreateReqVO createReqVO);

    /**
     * 更新投票
     *
     * @param updateReqVO 更新信息
     */
    void updateVote(@Valid VoteUpdateReqVO updateReqVO);

    /**
     * 删除投票
     *
     * @param id 编号
     */
    void deleteVote(Long id);

    /**
     * 批量删除投票
     *
     * @param ids 编号
     */
    void deleteByIds(List<Long> ids);

    /**
     * 获得投票
     *
     * @param id 编号
     * @return 投票
     */
    VoteDO getVote(Long id);

    /**
     * 获得投票列表
     *
     * @param ids 编号
     * @return 投票列表
     */
    List<VoteDO> getVoteList(Collection<Long> ids);

    /**
     * 获得投票分页
     *
     * @param pageReqVO 分页查询
     * @return 投票分页
     */
    PageResult<VoteDO> getVotePage(VotePageReqVO pageReqVO);

    /**
     * 获得投票列表, 用于 Excel 导出
     *
     * @param exportReqVO 查询条件
     * @return 投票列表
     */
    List<VoteDO> getVoteList(VoteListReqVO exportReqVO);

    /**
     * 投票
     *
     * @param id      投票id
     * @param itemIds 选项id
     * @param userId  用户id
     * @param ip      ip
     * @param cookie  cookie
     */
    void vote(Long id, List<Long> itemIds, @Nullable Long userId, String ip, long cookie);
}
